<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>silk.cli API documentation</title>
<meta name="description" content="silk - CLI …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>silk.cli</code></h1>
</header>
<section id="section-intro">
<h1 id="silk-cli">silk - CLI</h1>
<p>Highly configurable CLI tool for training, running inference and benchmarking.</p>
<h2 id="how-to-run-a-mode">How to run a mode ?</h2>
<p>A mode is a CLI command + parameters present in the configuration file <code>etc/mode/*.yaml</code>.
Running a mode without overriding any of its parameters can be done like this : <code>./bin/silk-cli mode=&lt;mode-name&gt;</code></p>
<h2 id="examples">Examples</h2>
<pre><code class="language-python"># start training the configured magicpoint model
./bin/silk-cli mode=train-magicpoint

# start benchmarking the configured magicpoint model
./bin/silk-cli mode=benchmark-magicpoint
</code></pre>
<p>Any parameter can be overridden since we are powered by <a href="https://hydra.cc">hydra</a>.</p>
<h2 id="examples_1">Examples</h2>
<pre><code class="language-python"># start training the configured magicpoint model on GPU 0 and 1 and disable output print
./bin/silk-cli mode=train-magicpoint 'mode.trainer.gpus=[0,1]' formatter=none
</code></pre>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python"># Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.

# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.

r&#34;&#34;&#34;# silk - CLI

    Highly configurable CLI tool for training, running inference and benchmarking.

    ## How to run a mode ?

    A mode is a CLI command + parameters present in the configuration file `etc/mode/*.yaml`.
    Running a mode without overriding any of its parameters can be done like this : `./bin/silk-cli mode=&lt;mode-name&gt;`

    Examples
    --------

    ```python
    # start training the configured magicpoint model
    ./bin/silk-cli mode=train-magicpoint

    # start benchmarking the configured magicpoint model
    ./bin/silk-cli mode=benchmark-magicpoint
    ```

    Any parameter can be overridden since we are powered by [hydra](https://hydra.cc).

    Examples
    --------

    ```python
    # start training the configured magicpoint model on GPU 0 and 1 and disable output print
    ./bin/silk-cli mode=train-magicpoint &#39;mode.trainer.gpus=[0,1]&#39; formatter=none
    ```

&#34;&#34;&#34;

import importlib
import os
from typing import Any

import hydra
import hydra.utils
import silk.logger as logger
from omegaconf import DictConfig
from silk.config import PACKAGE_NAME
from silk.config.paths import ROOT as ROOT_PATH
from silk.logger import LOG

COMMANDS = {
    &#34;training&#34;,
    &#34;inference&#34;,
    &#34;benchmark&#34;,
    &#34;check&#34;,
    &#34;cache_dataset&#34;,
    &#34;visualization&#34;,
    &#34;hpatches_tests&#34;,
    &#34;viewreid_tests&#34;,
    &#34;image_pair_visualization&#34;,
}


def _main_dispatch(command, cfg):
    module_name = f&#34;{PACKAGE_NAME}.cli.{command}&#34;
    module = importlib.import_module(module_name)
    LOG.success(f&#34;module `{module_name}` successfully imported&#34;)
    return module.main(cfg)


def _init_logger(cfg):
    for name in cfg.handlers:
        kwargs = hydra.utils.instantiate(cfg.handlers[name])
        logger.set_handler_options(name, **kwargs)
    logger.enable_handlers_only(*cfg.handlers.keys())


@LOG.catch(reraise=True)
def _main(cfg: DictConfig, working_dir: str) -&gt; Any:
    # check if command is correct
    if cfg.mode.command not in COMMANDS:
        raise RuntimeError(
            f&#39;mode.command=&#34;{cfg.mode.command}&#34; is not available (should be one of these {COMMANDS})&#39;
        )

    LOG.info(f&#34;run CLI in mode.command={cfg.mode.command}&#34;)

    formatter = hydra.utils.instantiate(cfg.formatter)

    LOG.success(f&#34;formatter `{cfg.formatter.name}` successfully instantiated&#34;)

    # run main command
    output = _main_dispatch(cfg.mode.command, cfg)
    LOG.success(&#34;main dispatch successfully executed&#34;)

    if output is not None:
        output = formatter(output)
        LOG.success(&#34;formatter successfully converted output&#34;)

        print(output)

    LOG.success(f&#34;ran successfully in working directory : {working_dir}&#34;)

    return output


def main(cfg: DictConfig) -&gt; Any:

    working_dir = os.path.relpath(os.getcwd(), ROOT_PATH)

    _init_logger(cfg.logger)

    try:
        return _main(cfg, working_dir)
    except BaseException:
        LOG.error(f&#34;run failed, `*.log` file might be found in : {working_dir}&#34;)
        if cfg.debug:
            raise
        exit(1)</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="silk.cli.benchmark" href="benchmark.html">silk.cli.benchmark</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="silk.cli.cache_dataset" href="cache_dataset.html">silk.cli.cache_dataset</a></code></dt>
<dd>
<div class="desc"><p>command : cache_dataset …</p></div>
</dd>
<dt><code class="name"><a title="silk.cli.check" href="check/index.html">silk.cli.check</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="silk.cli.hpatches_tests" href="hpatches_tests.html">silk.cli.hpatches_tests</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="silk.cli.image_pair_visualization" href="image_pair_visualization.html">silk.cli.image_pair_visualization</a></code></dt>
<dd>
<div class="desc"><p>Draw point correspondences between a pair of images …</p></div>
</dd>
<dt><code class="name"><a title="silk.cli.inference" href="inference.html">silk.cli.inference</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="silk.cli.training" href="training.html">silk.cli.training</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="silk.cli.visualization" href="visualization.html">silk.cli.visualization</a></code></dt>
<dd>
<div class="desc"><p>CLI function for PointTracking video visualization tool.</p></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="silk.cli.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>cfg: omegaconf.dictconfig.DictConfig) ‑> Any</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main(cfg: DictConfig) -&gt; Any:

    working_dir = os.path.relpath(os.getcwd(), ROOT_PATH)

    _init_logger(cfg.logger)

    try:
        return _main(cfg, working_dir)
    except BaseException:
        LOG.error(f&#34;run failed, `*.log` file might be found in : {working_dir}&#34;)
        if cfg.debug:
            raise
        exit(1)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul>
<li><a href="#silk-cli">silk - CLI</a><ul>
<li><a href="#how-to-run-a-mode">How to run a mode ?</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#examples_1">Examples</a></li>
</ul>
</li>
</ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="silk" href="../index.html">silk</a></code></li>
</ul>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="silk.cli.benchmark" href="benchmark.html">silk.cli.benchmark</a></code></li>
<li><code><a title="silk.cli.cache_dataset" href="cache_dataset.html">silk.cli.cache_dataset</a></code></li>
<li><code><a title="silk.cli.check" href="check/index.html">silk.cli.check</a></code></li>
<li><code><a title="silk.cli.hpatches_tests" href="hpatches_tests.html">silk.cli.hpatches_tests</a></code></li>
<li><code><a title="silk.cli.image_pair_visualization" href="image_pair_visualization.html">silk.cli.image_pair_visualization</a></code></li>
<li><code><a title="silk.cli.inference" href="inference.html">silk.cli.inference</a></code></li>
<li><code><a title="silk.cli.training" href="training.html">silk.cli.training</a></code></li>
<li><code><a title="silk.cli.visualization" href="visualization.html">silk.cli.visualization</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="silk.cli.main" href="#silk.cli.main">main</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>